

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
  <meta charset="utf-8" />
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  
  <title>Index &mdash; pysisso 0.3.2 documentation</title>
  

  
  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />

  
  

  
  

  

  
  <!--[if lt IE 9]>
    <script src="_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
        <script src="_static/jquery.js"></script>
        <script src="_static/underscore.js"></script>
        <script src="_static/doctools.js"></script>
    
    <script type="text/javascript" src="_static/js/theme.js"></script>

    
    <link rel="index" title="Index" href="#" />
    <link rel="search" title="Search" href="search.html" /> 
</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
          

          
            <a href="index.html" class="icon icon-home"> pysisso
          

          
          </a>

          
            
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        
        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <p class="caption"><span class="caption-text">Contents</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="tutorial/index.html">Get started</a></li>
<li class="toctree-l1"><a class="reference internal" href="how-to/index.html">How-to guides</a></li>
<li class="toctree-l1"><a class="reference internal" href="background/index.html">Background information</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference/index.html">Technical reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
</ul>

            
          
        </div>
        
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">pysisso</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          

















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
        
      <li>Index</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
          
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            

<h1 id="index">Index</h1>

<div class="genindex-jumpbox">
 <a href="#_"><strong>_</strong></a>
 | <a href="#A"><strong>A</strong></a>
 | <a href="#C"><strong>C</strong></a>
 | <a href="#D"><strong>D</strong></a>
 | <a href="#E"><strong>E</strong></a>
 | <a href="#F"><strong>F</strong></a>
 | <a href="#G"><strong>G</strong></a>
 | <a href="#I"><strong>I</strong></a>
 | <a href="#K"><strong>K</strong></a>
 | <a href="#L"><strong>L</strong></a>
 | <a href="#M"><strong>M</strong></a>
 | <a href="#N"><strong>N</strong></a>
 | <a href="#O"><strong>O</strong></a>
 | <a href="#P"><strong>P</strong></a>
 | <a href="#R"><strong>R</strong></a>
 | <a href="#S"><strong>S</strong></a>
 | <a href="#T"><strong>T</strong></a>
 
</div>
<h2 id="_">_</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="reference/index.html#pysisso.sklearn.SISSORegressor.__init__">__init__() (pysisso.sklearn.SISSORegressor method)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="A">A</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api/pysisso.html#pysisso.inputs.SISSOIn.AVAILABLE_OPERATIONS">AVAILABLE_OPERATIONS (pysisso.inputs.SISSOIn attribute)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="C">C</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api/pysisso.html#pysisso.validators.NormalCompletionValidator.check">check() (pysisso.validators.NormalCompletionValidator method)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="D">D</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api/pysisso.html#pysisso.outputs.DescriptorsDataModels">DescriptorsDataModels (class in pysisso.outputs)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="E">E</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api/pysisso.html#pysisso.outputs.SISSODescriptor.evaluate">evaluate() (pysisso.outputs.SISSODescriptor method)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="F">F</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api/pysisso.html#pysisso.outputs.FeatureSpace">FeatureSpace (class in pysisso.outputs)</a>
</li>
      <li><a href="api/pysisso.html#pysisso.sklearn.SISSORegressor.fit">fit() (pysisso.sklearn.SISSORegressor method)</a>
</li>
      <li><a href="api/pysisso.html#pysisso.inputs.SISSODat.from_dat_file">from_dat_file() (pysisso.inputs.SISSODat class method)</a>

      <ul>
        <li><a href="api/pysisso.html#pysisso.outputs.DescriptorsDataModels.from_dat_file">(pysisso.outputs.DescriptorsDataModels class method)</a>
</li>
      </ul></li>
      <li><a href="api/pysisso.html#pysisso.inputs.SISSODat.from_file">from_file() (pysisso.inputs.SISSODat class method)</a>

      <ul>
        <li><a href="api/pysisso.html#pysisso.inputs.SISSOIn.from_file">(pysisso.inputs.SISSOIn class method)</a>
</li>
        <li><a href="api/pysisso.html#pysisso.outputs.DescriptorsDataModels.from_file">(pysisso.outputs.DescriptorsDataModels class method)</a>
</li>
        <li><a href="api/pysisso.html#pysisso.outputs.SISSOOut.from_file">(pysisso.outputs.SISSOOut class method)</a>
</li>
      </ul></li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api/pysisso.html#pysisso.inputs.SISSOIn.from_SISSO_dat">from_SISSO_dat() (pysisso.inputs.SISSOIn class method)</a>
</li>
      <li><a href="api/pysisso.html#pysisso.inputs.SISSOIn.from_sisso_keywords">from_sisso_keywords() (pysisso.inputs.SISSOIn class method)</a>
</li>
      <li><a href="api/pysisso.html#pysisso.sklearn.SISSORegressor.from_SISSOIn">from_SISSOIn() (pysisso.sklearn.SISSORegressor class method)</a>
</li>
      <li><a href="api/pysisso.html#pysisso.outputs.SISSODescriptor.from_string">from_string() (pysisso.outputs.SISSODescriptor class method)</a>

      <ul>
        <li><a href="api/pysisso.html#pysisso.outputs.SISSOIteration.from_string">(pysisso.outputs.SISSOIteration class method)</a>
</li>
        <li><a href="api/pysisso.html#pysisso.outputs.SISSOModel.from_string">(pysisso.outputs.SISSOModel class method)</a>
</li>
        <li><a href="api/pysisso.html#pysisso.outputs.SISSOParams.from_string">(pysisso.outputs.SISSOParams class method)</a>
</li>
        <li><a href="api/pysisso.html#pysisso.outputs.SISSOVersion.from_string">(pysisso.outputs.SISSOVersion class method)</a>
</li>
      </ul></li>
  </ul></td>
</tr></table>

<h2 id="G">G</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api/pysisso.html#pysisso.sklearn.get_timestamp">get_timestamp() (in module pysisso.sklearn)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api/pysisso.html#pysisso.utils.get_version">get_version() (in module pysisso.utils)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="I">I</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api/pysisso.html#pysisso.jobs.SISSOJob.INPUT_FILE">INPUT_FILE (pysisso.jobs.SISSOJob attribute)</a>
</li>
      <li><a href="api/pysisso.html#pysisso.inputs.SISSODat.input_string">input_string() (pysisso.inputs.SISSODat property)</a>

      <ul>
        <li><a href="api/pysisso.html#pysisso.inputs.SISSOIn.input_string">(pysisso.inputs.SISSOIn method)</a>
</li>
      </ul></li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api/pysisso.html#pysisso.inputs.SISSOIn.is_classification">is_classification() (pysisso.inputs.SISSOIn property)</a>
</li>
      <li><a href="api/pysisso.html#pysisso.inputs.SISSOIn.is_regression">is_regression() (pysisso.inputs.SISSOIn property)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="K">K</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api/pysisso.html#pysisso.inputs.SISSOIn.KW_TYPES">KW_TYPES (pysisso.inputs.SISSOIn attribute)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="L">L</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api/pysisso.html#pysisso.utils.list_of_ints">list_of_ints() (in module pysisso.utils)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api/pysisso.html#pysisso.utils.list_of_strs">list_of_strs() (in module pysisso.utils)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="M">M</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api/pysisso.html#pysisso.utils.matrix_of_floats">matrix_of_floats() (in module pysisso.utils)</a>
</li>
      <li><a href="api/pysisso.html#pysisso.outputs.SISSOOut.model">model() (pysisso.outputs.SISSOOut property)</a>
</li>
      <li><a href="api/pysisso.html#pysisso.outputs.SISSOOut.models">models() (pysisso.outputs.SISSOOut property)</a>
</li>
      <li>
    module

      <ul>
        <li><a href="api.html#module-pysisso">pysisso</a>, <a href="api/pysisso.html#module-pysisso">[1]</a>
</li>
        <li><a href="api/pysisso.html#module-pysisso.inputs">pysisso.inputs</a>
</li>
        <li><a href="api/pysisso.html#module-pysisso.jobs">pysisso.jobs</a>
</li>
        <li><a href="api/pysisso.html#module-pysisso.outputs">pysisso.outputs</a>
</li>
        <li><a href="api/pysisso.html#module-pysisso.sklearn">pysisso.sklearn</a>
</li>
        <li><a href="api/pysisso.html#module-pysisso.utils">pysisso.utils</a>
</li>
        <li><a href="api/pysisso.html#module-pysisso.validators">pysisso.validators</a>
</li>
      </ul></li>
  </ul></td>
</tr></table>

<h2 id="N">N</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api/pysisso.html#pysisso.validators.NormalCompletionValidator">NormalCompletionValidator (class in pysisso.validators)</a>
</li>
      <li><a href="api/pysisso.html#pysisso.inputs.SISSODat.nsample">nsample() (pysisso.inputs.SISSODat property)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api/pysisso.html#pysisso.inputs.SISSODat.nsf">nsf() (pysisso.inputs.SISSODat property)</a>
</li>
      <li><a href="api/pysisso.html#pysisso.inputs.SISSODat.ntask">ntask() (pysisso.inputs.SISSODat property)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="O">O</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api/pysisso.html#pysisso.sklearn.SISSORegressor.OMP">OMP() (pysisso.sklearn.SISSORegressor class method)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="P">P</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api/pysisso.html#pysisso.outputs.SISSOParams.PARAMS">PARAMS (pysisso.outputs.SISSOParams attribute)</a>
</li>
      <li><a href="api/pysisso.html#pysisso.jobs.SISSOJob.postprocess">postprocess() (pysisso.jobs.SISSOJob method)</a>
</li>
      <li><a href="api/pysisso.html#pysisso.outputs.SISSOModel.predict">predict() (pysisso.outputs.SISSOModel method)</a>

      <ul>
        <li><a href="api/pysisso.html#pysisso.sklearn.SISSORegressor.predict">(pysisso.sklearn.SISSORegressor method)</a>
</li>
      </ul></li>
      <li>
    pysisso

      <ul>
        <li><a href="api.html#module-pysisso">module</a>, <a href="api/pysisso.html#module-pysisso">[1]</a>
</li>
      </ul></li>
      <li>
    pysisso.inputs

      <ul>
        <li><a href="api/pysisso.html#module-pysisso.inputs">module</a>
</li>
      </ul></li>
      <li>
    pysisso.jobs

      <ul>
        <li><a href="api/pysisso.html#module-pysisso.jobs">module</a>
</li>
      </ul></li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li>
    pysisso.outputs

      <ul>
        <li><a href="api/pysisso.html#module-pysisso.outputs">module</a>
</li>
      </ul></li>
      <li>
    pysisso.sklearn

      <ul>
        <li><a href="api/pysisso.html#module-pysisso.sklearn">module</a>
</li>
      </ul></li>
      <li>
    pysisso.utils

      <ul>
        <li><a href="api/pysisso.html#module-pysisso.utils">module</a>
</li>
      </ul></li>
      <li>
    pysisso.validators

      <ul>
        <li><a href="api/pysisso.html#module-pysisso.validators">module</a>
</li>
      </ul></li>
  </ul></td>
</tr></table>

<h2 id="R">R</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api/pysisso.html#pysisso.outputs.ResidualData">ResidualData (class in pysisso.outputs)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api/pysisso.html#pysisso.jobs.SISSOJob.run">run() (pysisso.jobs.SISSOJob method)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="S">S</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api/pysisso.html#pysisso.outputs.scd">scd() (in module pysisso.outputs)</a>
</li>
      <li><a href="api/pysisso.html#pysisso.inputs.SISSOIn.set_keywords_for_SISSO_dat">set_keywords_for_SISSO_dat() (pysisso.inputs.SISSOIn method)</a>
</li>
      <li><a href="api/pysisso.html#pysisso.jobs.SISSOJob.setup">setup() (pysisso.jobs.SISSOJob method)</a>
</li>
      <li><a href="api/pysisso.html#pysisso.inputs.SISSODat.SISSO_features_dimensions_ranges">SISSO_features_dimensions_ranges() (pysisso.inputs.SISSODat property)</a>
</li>
      <li><a href="api/pysisso.html#pysisso.inputs.SISSODat">SISSODat (class in pysisso.inputs)</a>
</li>
      <li><a href="api/pysisso.html#pysisso.outputs.SISSODescriptor">SISSODescriptor (class in pysisso.outputs)</a>
</li>
      <li><a href="api/pysisso.html#pysisso.inputs.SISSOIn">SISSOIn (class in pysisso.inputs)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api/pysisso.html#pysisso.outputs.SISSOIteration">SISSOIteration (class in pysisso.outputs)</a>
</li>
      <li><a href="api/pysisso.html#pysisso.jobs.SISSOJob">SISSOJob (class in pysisso.jobs)</a>
</li>
      <li><a href="api/pysisso.html#pysisso.outputs.SISSOModel">SISSOModel (class in pysisso.outputs)</a>
</li>
      <li><a href="api/pysisso.html#pysisso.outputs.SISSOOut">SISSOOut (class in pysisso.outputs)</a>
</li>
      <li><a href="api/pysisso.html#pysisso.outputs.SISSOParams">SISSOParams (class in pysisso.outputs)</a>
</li>
      <li><a href="api/pysisso.html#pysisso.sklearn.SISSORegressor">SISSORegressor (class in pysisso.sklearn)</a>, <a href="reference/index.html#pysisso.sklearn.SISSORegressor">[1]</a>
</li>
      <li><a href="api/pysisso.html#pysisso.outputs.SISSOVersion">SISSOVersion (class in pysisso.outputs)</a>
</li>
      <li><a href="api/pysisso.html#pysisso.utils.str_to_bool">str_to_bool() (in module pysisso.utils)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="T">T</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api/pysisso.html#pysisso.inputs.SISSODat.to_file">to_file() (pysisso.inputs.SISSODat method)</a>

      <ul>
        <li><a href="api/pysisso.html#pysisso.inputs.SISSOIn.to_file">(pysisso.inputs.SISSOIn method)</a>
</li>
      </ul></li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api/pysisso.html#pysisso.outputs.TopModels">TopModels (class in pysisso.outputs)</a>
</li>
      <li><a href="api/pysisso.html#pysisso.outputs.TopModelsCoefficients">TopModelsCoefficients (class in pysisso.outputs)</a>
</li>
      <li><a href="api/pysisso.html#pysisso.jobs.SISSOJob.TRAINING_DATA_DILE">TRAINING_DATA_DILE (pysisso.jobs.SISSOJob attribute)</a>
</li>
  </ul></td>
</tr></table>



           </div>
           
          </div>
          <footer>

  <hr/>

  <div role="contentinfo">
    <p>
        &#169; Copyright 2020, Matgenix SRL.

    </p>
  </div>
    
    
    
    Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    
    provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>
        </div>
      </div>

    </section>

  </div>
  

  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
  
    
   

</body>
</html>